home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAccessibleRetrieval.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  5.5 KB  |  129 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2003
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Original Author: Aaron Leventhal (aaronl@netscape.com)
  23.  * Contributor(s): Kyle Yuan (kyle.yuan@sun.com)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40.  
  41. interface nsIDOMNode;
  42. interface nsIAccessible;
  43. interface nsIWeakReference;
  44. interface nsIPresShell;
  45. interface nsIDOMWindow;
  46. interface nsIAccessNode;
  47.  
  48. /**
  49.  * An interface for in-process accessibility clients
  50.  * wishing to get an nsIAccessible or nsIAccessNode for
  51.  * a given DOM node.
  52.  * More documentation at:
  53.  *   http://www.mozilla.org/projects/ui/accessibility
  54.  *
  55.  * @status UNDER_REVIEW
  56.  */
  57. [scriptable, uuid(663CA4A8-D219-4000-925D-D8F66406B626)]
  58. interface nsIAccessibleRetrieval : nsISupports
  59. {
  60.   /**
  61.    * Return an nsIAccessible for a DOM node in pres shell 0.
  62.    * Create a new accessible of the appropriate type if necessary,
  63.    * or use one from the accessibility cache if it already exists.
  64.    * @param aNode The DOM node to get an accessible for.
  65.    * @return The nsIAccessible for the given DOM node.
  66.    */
  67.   nsIAccessible getAccessibleFor(in nsIDOMNode aNode);
  68.  
  69.   /**
  70.    * Return an nsIAccessible for a DOM node in pres shell for this DOM window.
  71.    * Create a new accessible of the appropriate type if necessary,
  72.    * or use one from the accessibility cache if it already exists.
  73.    * @param aNode   The DOM node to get an accessible for.
  74.    * @param aDOMWin The DOM window containing the node.
  75.    * @return The nsIAccessible for the given DOM node.
  76.    */
  77.   nsIAccessible getAccessibleInWindow(in nsIDOMNode aNode, in nsIDOMWindow aDOMWin);
  78.  
  79.   /**
  80.    * Return an nsIAccessible for a DOM node in the given weak shell.
  81.    * Create a new accessible of the appropriate type if necessary,
  82.    * or use one from the accessibility cache if it already exists.
  83.    * @param aNode      The DOM node to get an accessible for.
  84.    * @param aPresShell The presentation shell which contains layout info for the DOM node.
  85.    * @return The nsIAccessible for the given DOM node.
  86.    */
  87.   nsIAccessible getAccessibleInWeakShell(in nsIDOMNode aNode, in nsIWeakReference aPresShell);
  88.  
  89.   /**
  90.    * Return an nsIAccessible for a DOM node in the given pres shell.
  91.    * Create a new accessible of the appropriate type if necessary,
  92.    * or use one from the accessibility cache if it already exists.
  93.    * @param aNode      The DOM node to get an accessible for.
  94.    * @param aPresShell The presentation shell which contains layout info for the DOM node.
  95.    * @return The nsIAccessible for the given DOM node.
  96.    */
  97.   nsIAccessible getAccessibleInShell(in nsIDOMNode aNode, in nsIPresShell aPresShell);
  98.   
  99.    /**
  100.     * Return an nsIAccessNode for an already created DOM node in the given weak shell.
  101.     * Does not create a new one -- only returns cached access nodes.
  102.     * @param aNode      The DOM node to get an access node for.
  103.     * @param aPresShell The presentation shell which contains layout info for the DOM node.
  104.     * @return The nsIAccessNode for the given DOM node or null if
  105.     *         an access node does not already exist for this DOM node.
  106.     */
  107.   nsIAccessNode getCachedAccessNode(in nsIDOMNode aNode, in nsIWeakReference aShell);
  108.  
  109.    /**
  110.     * Return an nsIAccessible for an already created DOM node in the given weak shell.
  111.     * Does not create a new one -- only returns cached accessibles.
  112.     * @param aNode      The DOM node to get an accessible for.
  113.     * @param aPresShell The presentation shell which contains layout info for the DOM node.
  114.     * @return The nsIAccessible for the given DOM node or null if
  115.     *         an accessible does not already exist for this DOM node.
  116.     */
  117.   nsIAccessible getCachedAccessible(in nsIDOMNode aNode, in nsIWeakReference aShell);
  118. };
  119.  
  120.  
  121. %{ C++
  122.  
  123. // for component registration
  124. // {663CA4A8-D219-4000-925D-D8F66406B626}
  125. #define NS_ACCESSIBLE_RETRIEVAL_CID \
  126. { 0x663ca4a8, 0xd219, 0x4000, { 0x92, 0x5d, 0xd8, 0xf6, 0x64, 0x6, 0xb6, 0x26 } }
  127.  
  128. %}
  129.